/*!	 waypointsimpleadd.cpp
**	 Simple add waypoint File
**
**	Copyright (c) 2004 Adrian Bentley
**
**	This package is free software; you can redistribute it and/or
**	modify it under the terms of the GNU General Public License as
**	published by the Free Software Foundation; either version 2 of
**	the License, or (at your option) any later version.
**
**	This package is distributed in the hope that it will be useful,
**	but WITHOUT ANY WARRANTY; without even the implied warranty of
**	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
**	General Public License for more details.
**
*/

#ifdef USING_PCH
#	include "pch.h"
#else
#ifdef HAVE_CONFIG_H
#	include <config.h>
#endif

#include <synfig/general.h>

#include "waypointsimpleadd.h"
#include <synfigapp/canvasinterface.h>

#include <synfigapp/localization.h>

#endif

using namespace std;
using namespace etl;
using namespace synfig;
using namespace synfigapp;
using namespace Action;

ACTION_INIT(Action::WaypointSimpleAdd);
ACTION_SET_NAME(Action::WaypointSimpleAdd, "WaypointSimpleAdd");
ACTION_SET_LOCAL_NAME(Action::WaypointSimpleAdd, N_("Simply Add Waypoint"));
ACTION_SET_TASK(Action::WaypointSimpleAdd, "add");
ACTION_SET_CATEGORY(Action::WaypointSimpleAdd, Action::CATEGORY_WAYPOINT);
ACTION_SET_PRIORITY(Action::WaypointSimpleAdd, 0);
ACTION_SET_VERSION(Action::WaypointSimpleAdd, "0.0");
ACTION_SET_CVS_ID(Action::WaypointSimpleAdd, "$Id$");

Action::WaypointSimpleAdd::WaypointSimpleAdd():
    time_overwrite()
{
    set_dirty(true);
    waypoint.set_time(Time::begin() - 1);
}

Action::ParamVocab
Action::WaypointSimpleAdd::get_param_vocab()
{
    ParamVocab ret(Action::CanvasSpecific::get_param_vocab());

    ret.push_back(ParamDesc("value_node", Param::TYPE_VALUENODE)
                  .set_local_name(_("Destination ValueNode (Animated)"))
                 );

    ret.push_back(ParamDesc("waypoint", Param::TYPE_WAYPOINT)
                  .set_local_name(_("Waypoint"))
                  .set_desc(_("Waypoint to be added"))
                 );

    return ret;
}

bool
Action::WaypointSimpleAdd::is_candidate(const ParamList &x)
{
    return candidate_check(get_param_vocab(), x);
}

bool
Action::WaypointSimpleAdd::set_param(const synfig::String& name, const Action::Param &param)
{
    if (name == "value_node" && param.get_type() == Param::TYPE_VALUENODE) {
        value_node = ValueNode_Animated::Handle::cast_dynamic(param.get_value_node());

        return static_cast<bool>(value_node);
    }

    if (name == "waypoint" && param.get_type() == Param::TYPE_WAYPOINT) {
        waypoint = param.get_waypoint();

        return true;
    }

    return Action::CanvasSpecific::set_param(name, param);
}

bool
Action::WaypointSimpleAdd::is_ready()const
{
    if (!value_node && waypoint.get_time() != (Time::begin() - 1)) {
        return false;
    }

    return Action::CanvasSpecific::is_ready();
}

void
Action::WaypointSimpleAdd::perform()
{
    // remove any pretenders that lie at our destination
    ValueNode_Animated::findresult iter = value_node->find_time(waypoint.get_time());

    time_overwrite = false;

    if (iter.second) {
        overwritten_wp = *iter.first;
        time_overwrite = true;
        value_node->erase(overwritten_wp);
    }

    // add the value node in since it's safe
    value_node->add(waypoint);

    // Signal that a valuenode has been changed
    value_node->changed();
}

void
Action::WaypointSimpleAdd::undo()
{
    // remove our old version...
    ValueNode_Animated::findresult iter = value_node->find_uid(waypoint);

    if (!iter.second) {
        throw Error(_("The waypoint to remove no longer exists"));
    }

    // remove the offending value
    value_node->erase(*iter.first); // could also just use waypoint

    if (time_overwrite) {
        value_node->add(overwritten_wp);
    }

    // Signal that a valuenode has been changed
    value_node->changed();
}